home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / telecomm / bbs / wwbbs.lha / WWBBS / Programming / Library.doc next >
Text File  |  1994-09-18  |  3KB  |  126 lines
  1. TABLE OF CONTENTS
  2.  
  3. wwbbs.lib/Ask
  4. wwbbs.lib/GetLine
  5. wwbbs.lib/ShowText
  6. wwbbs.library/--config--
  7. wwbbs.library/GetConfig
  8. wwbbs.library/SetConfig
  9. wwbbs.library/AddConfig
  10. wwbbs.library/RemConfig
  11. wwbbs.library/--status--
  12. wwbbs.library/GetStatus
  13. wwbbs.library/SetStatus
  14. wwbbs.library/AddStatus
  15. wwbbs.library/RemStatus
  16. wwbbs.library/--user--
  17. wwbbs.library/GetUser
  18. wwbbs.library/SetUser
  19. wwbbs.library/AddUser
  20. wwbbs.library/RemUser
  21. wwbbs.library/LoadUser
  22. wwbbs.library/UnLoadUser
  23. wwbbs.library/NodeCommand
  24. wwbbs.library/ConsoleCommand
  25. wwbbs.library/SerialCommand
  26. wwbbs.library/TimerCommand
  27. wwbbs.library/SetUpdatePort
  28. wwbbs.library/SendUpdate
  29. wwbbs.library/LogEntry
  30. wwbbs.library/IsRange
  31. wwbbs.lib/Ask
  32.  
  33.    NAME
  34.     Ask -- Ask user something, yes or no
  35.  
  36.    SYNOPSIS
  37.     result = Ask(prompt,default)
  38.  
  39.     BOOL Ask(BYTE *,BOOL);
  40.  
  41.    FUNCTION
  42.     Prints a prompt if specified and waits for a yes or no answer.  Works
  43.     through Input().
  44.  
  45.    INPUTS
  46.     prompt - Prompt text.  You do not need to specify any formatting
  47.              characters, only the text.
  48.     default - Set default answer to yes or no, TRUE or FALSE.
  49.  
  50.    RESULT
  51.     result - TRUE is user selected yes, otherwise FALSE
  52. wwbbs.lib/GetLine
  53.  
  54.    NAME
  55.     GetLine -- Get a line from user
  56.  
  57.    SYNOPSIS
  58.     success = GetLine(id,buffer,length,flags)
  59.  
  60.     BOOL GetLine(BYTE *,BYTE *,UWORD,ULONG)
  61.  
  62.    FUNCTION
  63.     Gets a line from the user, using flags to define behavior.  Works
  64.     through Input().
  65.  
  66.    INPUTS
  67.     id - Node id.  Get this from the NODE environment variable.
  68.     buffer - Where to put text inputted from the user.  Make sure it is big
  69.              enough to hold length chars + NULL terminator.
  70.     length - Maximum length of input line.
  71.     flags - These flags define the behavior of this function:
  72.  
  73.        GLFLG_Edit - Begin with whatever is in buffer and allow user to edit
  74.                     it.  Otherwise it will automatically clear buffer.
  75.        GLFLG_NoEcho - Do not echo inputted characters.
  76.        GLFLG_NoEmpty - Do not allow an empty line to be returned.  Note
  77.                        that it may return an empty line if a panic
  78.                        situation happens, such as a loss of carrier.  
  79.        GLFLG_Format - Capitalize first letters of words.
  80.        GLFLG_ToLower - Make all letters lowercase.
  81.        GLFLG_ToUpper - Make all letters uppercase.
  82.        GLFLG_Chars - Only allow characters in the alphabet.
  83.        GLFLG_Digits - Only allow digits.
  84.        GLFLG_NoChars - No characters.
  85.        GLFLG_NoDigits - No digits.
  86.        GLFLG_NoSpaces - No spaces.
  87.        GLFLG_NoPunct - No punctuation characters.
  88.        GLFLG_BeginChar - Must begin with a character in the alphabet.
  89.        GLFLG_BeginDigit - Must begin with a digit.
  90.  
  91.    RESULT
  92.     success - Was it successful?
  93. wwbbs.lib/ShowText
  94.  
  95.    NAME
  96.     ShowText -- Show a text file
  97.  
  98.    SYNOPSIS
  99.     ShowText(file)
  100.  
  101.     void ShowText(BYTE *);
  102.  
  103.    FUNCTION
  104.     Show a text file.
  105.  
  106.    INPUTS
  107.     file - Name of file to show.
  108. wwbbs.library/LogEntry
  109.  
  110.    NAME
  111.     LogEntry(id,log,text)
  112.  
  113.    SYNOPSIS
  114.     LogEntry(id,log,text)
  115.  
  116.     void LogEntry(BYTE *,BYTE *,BYTE *);
  117.  
  118.    FUNCTION
  119.     Make a log entry.
  120.  
  121.    INPUTS
  122.     id - Node id.  Get this from the NODE environment variable.
  123.     log - Log id.  This is used to categorize log entries.
  124.     text - Log entry text.  Please keep your text less than about 60 chars.
  125. wwbbs.library/IsRange
  126.